Version Control with git and Github


Sep Dadsetan, PhD - Executive Director, RWD Analytics at

2024-03-09


r fontawesome::fa("linkedin", "black")   linkedin.com/in/sepdadsetan/

Introduction

Overview of today’s agenda:

  • Introduction (30 minutes)
  • Assignment 1: Git Basics (45 minutes)
  • Assignment 2: Branching and Merging (45 minutes)
  • Break (15 minutes)
  • Assignment 3: Working with GitHub (1 hour)
  • Assignment 4: Collaborating on GitHub (45 minutes)
  • Closing (10 minutes)

Section 1: Importance of Version Control

Version control is a system that records changes to a file or set of files over time so that you can recall specific versions later. It’s a critical practice in software development and has become increasingly important in data science as well. Here’s why:

1. Collaboration

Data science often involves collaboration among multiple team members. Version control systems like Git allow multiple people to work on the same project simultaneously. They can make changes, submit them for review, and merge them into the main project without overwriting each other’s work.

2. Reproducibility

In data science, it’s crucial to be able to reproduce results. By keeping track of the exact versions of code, data, and libraries used, version control helps ensure that experiments can be replicated precisely. This is vital for both validation of results and for future work that builds on previous findings.

3. Experimentation

Data scientists often need to try out different models, features, or hyperparameters. Version control allows them to create branches where they can experiment without affecting the main project. If an experiment is successful, it can be merged back into the main codebase; if not, it can be discarded without any mess.

4. Accountability

Version control maintains a detailed log of who made what changes and when. This is essential for understanding the evolution of a project and can be crucial for regulatory compliance in some industries.

5. Backup and Recovery

Mistakes happen, and code can be lost or broken. Version control acts as a continuous backup, allowing you to revert to previous versions if something goes wrong. This can save hours or even days of work.

6. Code Quality

Through code reviews and the ability to track changes over time, version control can help maintain and improve the quality of the code. It encourages best practices and helps prevent “code rot” where code becomes unmaintained and outdated.

7. Integration with Other Tools

Version control systems often integrate with other tools used in data science, such as continuous integration systems, project management tools, and code notebooks. This can streamline workflows and make the entire process more efficient.

Summary

Version control is not just a tool for software developers. It’s an essential part of modern data science, enabling collaboration, reproducibility, experimentation, and much more. By providing a structured way to manage changes, track history, and integrate with other tools, version control systems like Git help data scientists work more efficiently and effectively.

Section 2: Dive into Git

  • Introduction to Git as a distributed version control system
  • Basic commands and workflow (add/stage, commit, log)
  • Branching and merging in Git
  • Demonstration with a simple project

Git Concepts - Simplified

Imagine you’re working on a big puzzle with your friends, and you want to make sure that you can always go back to see how the puzzle looked at different stages. Version control is like taking a picture of the puzzle every time you add a few pieces.

Here’s how it works:

(Repository) - Starting the Puzzle: When you first open the puzzle box, that’s like starting a new project. In version control, this is called creating a “repository.” It’s the place where all the pictures of your puzzle will be stored.

(Commits) - Adding Pieces: Every time you and your friends add some pieces to the puzzle and are happy with how it looks, you take a picture. In version control, this picture is called a “commit.” It’s a snapshot of how everything looks at that moment.

(Branches) - Trying New Things: Sometimes, you might want to try putting together a part of the puzzle without messing up what you’ve already done. You can take the current picture and make a copy to work on. This is called a “branch.” If you like what you’ve done in the branch, you can add it back to the main puzzle. If not, you can just throw that copy away.

(Collaboration) - Working with Friends: Version control lets you and your friends work on the puzzle together without getting in each other’s way. You can all take turns adding pieces and taking pictures, and if someone makes a mistake, you can always look at the previous pictures to see what went wrong.

(History) - Going Back in Time: If you ever want to see how the puzzle looked at any earlier stage, you can look at the pictures you’ve taken along the way. This is the “history” in version control, and it lets you go back in time to see how things have changed.

(Backup) - Keeping Everything Safe: If something happens to the puzzle, like if your little sibling messes it up, you still have all the pictures you’ve taken. You can use those pictures to put the puzzle back the way it was.

So, version control is like a magical camera for your projects. It lets you take pictures of what you’re working on, try new things without worry, work with friends, and even go back in time if you need to. It’s a way to make sure that you can always see how your puzzle—or your project—has grown and changed.

Basic Git Usage and Concepts - Lesson 1

Adding and Committing

Basic Git Usage and Concepts - Lesson 2

Branching

Break (20 min)

  • Meet, socialize, refresh

Working with Github

  • Explanation and Demonstration (20 minutes): Introduce GitHub, explaining forks, clones, and pull requests. Demonstrate how to perform these actions.
  • Hands-on Practice (35 minutes): Students fork the repository, clone it, make changes, and submit a pull request.
  • Review and Q&A (5 minutes): Discuss the process, highlighting the importance of collaboration in software development.

Collaborating on Github

  • Explanation and Demonstration (15 minutes): Explain GitHub issues and project boards. Show how to create issues, set up a project board, and manage tasks.
  • Hands-on Practice (25 minutes): Students create an issue related to their previous pull request and manage it on a project board.
  • Review and Q&A (5 minutes): Wrap up by discussing how these tools facilitate project management and teamwork.

Thank You’s

  • First of all, everyone for listening and participating
  • SoCal RUG and Organizers for having me
  • Developers behind these wonderful tools
    • Linus Torvalds, Junio Hamano, et. al. for Git
    • The software development community!

Helpful Resources